<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Action</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Action</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|													<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Action class</p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeroen Simons &lt;<a href="mailto:jeroen@melange.nl">jeroen@melange.nl</a>&gt;</li>
				<li><span class="field">copyright:</span> Copyright (c) 2007 Jeroen Simons. All rights reserved</li>
				<li><span class="field">link:</span> <a href="http://www.melange.nl/">http://www.melange.nl/</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_mvc---action---Action.php.html">/mvc/action/Action.php</a> (line <span class="field">35</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../mvc/MappingDispatchAction.html">MappingDispatchAction</a></td>
					<td>
											MappingDispatchAction class
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../mvc/RedirectAction.html">RedirectAction</a></td>
					<td>
											RedirectAction class
										</td>
				</tr>
							</table>
		</div>
	</div>



	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																												
												<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addErrors" title="details" class="method-name">addErrors</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../mvc/ActionMessages.html">ActionMessages</a></span>&nbsp;<span class="var-name">$errors</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addMessages" title="details" class="method-name">addMessages</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../mvc/ActionMessages.html">ActionMessages</a></span>&nbsp;<span class="var-name">$messages</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#generateToken" title="details" class="method-name">generateToken</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">the</span>
										<a href="#getErrors" title="details" class="method-name">getErrors</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">the</span>
										<a href="#getMessages" title="details" class="method-name">getMessages</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><code>true</code></span>
										<a href="#isCancelled" title="details" class="method-name">isCancelled</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><code>true</code></span>
										<a href="#isTokenValid" title="details" class="method-name">isTokenValid</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$reset</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#resetToken" title="details" class="method-name">resetToken</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#saveErrors" title="details" class="method-name">saveErrors</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../mvc/ActionMessages.html">ActionMessages</a></span>&nbsp;<span class="var-name">$errors</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$inSession</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#saveMessages" title="details" class="method-name">saveMessages</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../mvc/ActionMessages.html">ActionMessages</a></span>&nbsp;<span class="var-name">$messages</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$inSession</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#saveToken" title="details" class="method-name">saveToken</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodaddErrors" id="addErrors"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">addErrors</span> (line <span class="line-number">218</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds the specified errors keys into the appropriate request attribute  for use by the &amp;lt;html:errors&amp;gt; tag, if any messages are required.</p>
<p class="description"><p>Initialize the attribute if it has not already been. Otherwise, ensure  that the request attribute is not set.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addErrors
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../mvc/ActionMessages.html">ActionMessages</a></span>&nbsp;<span class="var-name">$errors</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">errors</span>
				<span class="var-name">$errors</span><span class="var-description">: Errors object</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaddMessages" id="addMessages"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">addMessages</span> (line <span class="line-number">180</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds the specified messages keys into the appropriate request attribute  for use by the &amp;lt;html:messages&amp;gt; tag (if messages=&quot;true&quot; is set),  if any messages are required. Initialize the attribute if it has not  already been. Otherwise, ensure that the request attribute is not set.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addMessages
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../mvc/ActionMessages.html">ActionMessages</a></span>&nbsp;<span class="var-name">$messages</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">messages</span>
				<span class="var-name">$messages</span><span class="var-description">: Messages object</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgenerateToken" id="generateToken"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">generateToken</span> (line <span class="line-number">52</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Generate a new transaction token, to be used for enforcing a single  request for a particular transaction.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> new transaction token.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			generateToken
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The request we are processing</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetErrors" id="getErrors"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getErrors</span> (line <span class="line-number">136</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves any existing errors placed in the request by previous  actions. This method could be called instead of creating a <div class="src-code"><ol><li><div class="src-line"><span class="src-key">new</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-id"><a href="../mvc/ActionMessages.html">ActionMessages</a></span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div> at the beginning of an <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../mvc/Action.html">Action</a></span></div></li>
</ol></div>.</p>
<p class="description"><p>This will prevent saveErrors() from wiping out any existing Errors</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Errors that already exist in the request, or a new          ActionMessages object if empty.</li>
				<li><span class="field">since:</span> Struts 1.2.1</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">the</span>
		<span class="method-name">
			getErrors
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetMessages" id="getMessages"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getMessages</span> (line <span class="line-number">159</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt; Retrieves any existing messages placed in the request by previous</p>
<p class="description"><p>actions. This method could be called instead of creating a <div class="src-code"><ol><li><div class="src-line"><span class="src-key">new</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-id"><a href="../mvc/ActionMessages.html">ActionMessages</a></span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div> at the beginning of an <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../mvc/Action.html">Action</a></span></div></li>
</ol></div> This  will prevent saveMessages() from wiping out any existing Messages &lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Messages that already exist in the request, or a new          ActionMessages object if empty.</li>
				<li><span class="field">since:</span> Struts 1.2.1</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">the</span>
		<span class="method-name">
			getMessages
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisCancelled" id="isCancelled"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isCancelled</span> (line <span class="line-number">338</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Returns <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if the current form's cancel button was</p>
<p class="description"><p>pressed. This method will check if the <div class="src-code"><ol><li><div class="src-line"><span class="src-id">CANCEL_KEY</span></div></li>
</ol></div>  request attribute has been set, which normally occurs if the cancel  button generated by &lt;strong&gt;CancelTag&lt;/strong&gt; was pressed by the user  in the current request. If <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div>, validation performed by  an &lt;strong&gt;ActionForm&lt;/strong&gt;'s <div class="src-code"><ol><li><div class="src-line"><span class="src-id">validate</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div> method will  have been skipped by the controller servlet.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> if the cancel button was pressed;          <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> otherwise.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><code>true</code></span>
		<span class="method-name">
			isCancelled
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The request we are processing</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisTokenValid" id="isTokenValid"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isTokenValid</span> (line <span class="line-number">84</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if there is a transaction token stored in</p>
<p class="description"><p>the user's current session, and the value submitted as a request  parameter with this action matches it. Returns <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> under  any of the following circumstances:&lt;/p&gt;</p><p><ul><li>No session associated with this request</li><li>No transaction token saved in the session</li><li>No transaction token included as a request parameter</li><li>The included transaction token value does not match the transaction
 token in the user's session</li></ul></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> if there is a transaction token and it is          valid; <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> otherwise.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><code>true</code></span>
		<span class="method-name">
			isTokenValid
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$reset</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$reset</span>			</li>
				</ul>
		
			
	</div>
<a name="methodresetToken" id="resetToken"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">resetToken</span> (line <span class="line-number">100</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Reset the saved transaction token in the user's session. This  indicates that transactional token checking will not be needed on the  next request that is submitted.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			resetToken
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsaveErrors" id="saveErrors"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">saveErrors</span> (line <span class="line-number">257</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Save the specified error messages keys into the appropriate request</p>
<p class="description"><p>attribute for use by the &amp;lt;html:errors&amp;gt; tag, if any messages are  required. Otherwise, ensure that the request attribute is not  created.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">since:</span> Struts 1.2</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			saveErrors
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../mvc/ActionMessages.html">ActionMessages</a></span>&nbsp;<span class="var-name">$errors</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$inSession</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">errors</span>
				<span class="var-name">$errors</span><span class="var-description">: Error messages object</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$inSession</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsaveMessages" id="saveMessages"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">saveMessages</span> (line <span class="line-number">297</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Save the specified messages keys into the appropriate request</p>
<p class="description"><p>attribute for use by the &amp;lt;html:messages&amp;gt; tag (if messages=&quot;true&quot;  is set), if any messages are required. Otherwise, ensure that the  request attribute is not created.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">since:</span> Struts 1.1</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			saveMessages
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../mvc/ActionMessages.html">ActionMessages</a></span>&nbsp;<span class="var-name">$messages</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$inSession</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing.</span>			</li>
					<li>
				<span class="var-type">messages</span>
				<span class="var-name">$messages</span><span class="var-description">: The messages to save. <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div> or empty                  messages removes any existing ActionMessages in the                  request.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$inSession</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsaveToken" id="saveToken"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">saveToken</span> (line <span class="line-number">115</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Save a new transaction token in the user's current session, creating  a new session if necessary.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			saveToken
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 10 Feb 2008 15:16:13 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>